<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta content="en" name="language">
	<title>decorate</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
	<link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet">

</head>

<body>

<div class="banner">
<img src="../images/gm-107x76.png" alt="GraphicMagick logo" width="107" height="76" />
<span class="title">GraphicsMagick</span>
<form action="http://www.google.com/search">
  <input type="hidden" name="domains" value="www.graphicsmagick.org" />
  <input type="hidden" name="sitesearch" value="www.graphicsmagick.org" />
<span class="nowrap"><input type="text" name="q" size="25" maxlength="255" />&nbsp;<input type="submit" name="sa" value="Search" /></span>
</form>
</div>


<div class="navmenu">
<ul>
  <li><a href="../index.html">Home</a></li>
  <li><a href="../project.html">Project</a></li>
  <li><a href="../download.html">Download</a></li>
  <li><a href="../README.html">Install</a></li>
  <li><a href="../Hg.html">Source</a></li>
  <li><a href="../NEWS.html">News</a> </li>
  <li><a href="../utilities.html">Utilities</a></li>
  <li><a href="../programming.html">Programming</a></li>
  <li><a href="../reference.html">Reference</a></li>
</ul>
</div>

<main id="decorate">
<h1 class="title">decorate</h1>
<p class="subtitle" id="add-decorative-frames-and-borders">Add decorative frames and borders</p>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#borderimage" id="id5">BorderImage</a></p></li>
<li><p><a class="reference internal" href="#frameimage" id="id6">FrameImage</a></p></li>
<li><p><a class="reference internal" href="#raiseimage" id="id7">RaiseImage</a></p></li>
</ul>
</div>
<section id="borderimage">
<h1><a class="toc-backref" href="#id5">BorderImage</a></h1>
<section id="synopsis">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *BorderImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *border_info,
                    <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</section>
<section id="description">
<h2>Description</h2>
<p>BorderImage() surrounds the image with a border of the color defined by
the bordercolor member of the image structure.  The width and height
of the border are defined by the corresponding members of the border_info
structure.</p>
<p>The format of the BorderImage method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *BorderImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *border_info,
                    <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<dl class="simple">
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
<dt>border_info:</dt>
<dd><p>Define the width and height of the border.</p>
</dd>
<dt>exception:</dt>
<dd><p>Return any errors or warnings in this structure.</p>
</dd>
</dl>
</section>
</section>
<section id="frameimage">
<h1><a class="toc-backref" href="#id6">FrameImage</a></h1>
<section id="id1">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *FrameImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#frameinfo">FrameInfo</a> *frame_info,
                   <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</section>
<section id="id2">
<h2>Description</h2>
<p>FrameImage() adds a simulated three-dimensional border around the image.
The color of the border is defined by the matte_color member of image.
Members width and height of frame_info specify the border width of the
vertical and horizontal sides of the frame.  Members inner and outer
indicate the width of the inner and outer shadows of the frame.</p>
<p>The format of the FrameImage method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#image">Image</a> *FrameImage( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#frameinfo">FrameInfo</a> *frame_info,
                   <a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<dl class="simple">
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
<dt>frame_info:</dt>
<dd><p>Define the width and height of the frame and its bevels.</p>
</dd>
<dt>exception:</dt>
<dd><p>Return any errors or warnings in this structure.</p>
</dd>
</dl>
</section>
</section>
<section id="raiseimage">
<h1><a class="toc-backref" href="#id7">RaiseImage</a></h1>
<section id="id3">
<h2>Synopsis</h2>
<pre class="literal-block">unsigned int RaiseImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *raise_info,
                         const int raise_flag );</pre>
</section>
<section id="id4">
<h2>Description</h2>
<p>RaiseImage() creates a simulated three-dimensional button-like effect
by lightening and darkening the edges of the image.  Members width and
height of raise_info define the width of the vertical and horizontal
edge of the effect.</p>
<p>The format of the RaiseImage method is:</p>
<pre class="literal-block">unsigned int RaiseImage( <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#rectangleinfo">RectangleInfo</a> *raise_info,
                         const int raise_flag );</pre>
<dl class="simple">
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
<dt>raise_info:</dt>
<dd><p>Define the width and height of the raise area.</p>
</dd>
<dt>raise_flag:</dt>
<dd><p>A value other than zero creates a 3-D raise effect,
otherwise it has a lowered effect.</p>
</dd>
</dl>
</section>
</section>
</main>


<hr class="docutils">
<div class="document">
    <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002-2025<!--SPONSOR_LOGO--></p>
</div>

</main>
</body>
</html>
